App Configuration - Snapshot references #44116

mrm9084 · 2025-11-20T17:11:28Z

Description

Please add an informative description that covers that changes made by the pull request and link all relevant issues.

If an SDK is being regenerated based on a new API spec, a link to the pull request containing these API spec changes should be included above.

All SDK Contribution checklist:

The pull request does not introduce [breaking changes]
CHANGELOG is updated for new features, bug fixes or other significant changes.
I have read the contribution guidelines.

General Guidelines and Best Practices

Title of the pull request is clear and informative.
There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

Pull request includes test coverage for the included changes.

Copilot

Pull Request Overview

This pull request adds support for snapshot references in the Azure App Configuration Provider SDK for Python. Snapshot references allow configuration settings to reference entire snapshots, which are then resolved and merged into the configuration at load time. This feature enables better configuration management by allowing users to group related settings into snapshots and reference them dynamically.

Key Changes:

Introduced snapshot reference parsing and resolution functionality with recursive processing support
Added telemetry tracking for snapshot reference usage via the request tracing context
Extended both synchronous and asynchronous providers to handle snapshot reference resolution

Reviewed Changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 14 comments.

Show a summary per file

File	Description
`_constants.py`	Added constants for snapshot reference MIME profile, content type, and telemetry tag
`_snapshot_reference_parser.py`	New parser class for validating and extracting snapshot names from reference JSON
`_client_manager.py`	Added `resolve_snapshot_reference` method to resolve snapshot references to actual settings
`aio/_async_client_manager.py`	Async version of snapshot reference resolution functionality
`_azureappconfigurationprovider.py`	Modified `_process_configurations` to detect and resolve snapshot references recursively
`aio/_azureappconfigurationproviderasync.py`	Async version of snapshot reference processing in configuration loading
`_azureappconfigurationproviderbase.py`	Added telemetry tracking for snapshot reference content type detection
`_request_tracing_context.py`	Added `uses_snapshot_reference` flag and correlation context header support
`test_snapshot_references.py`	Unit tests for snapshot reference parser validation logic
`test_snapshot_references_integration.py`	Integration tests for snapshot reference parsing and content type detection
`aio/test_async_snapshot_references_integration.py`	Async integration tests for snapshot reference resolution in client manager and provider
`test_request_tracing_context.py`	Tests for snapshot reference telemetry tracking in correlation context
`refresh_sample.py`	Unrelated sample modifications that should be reverted

...guration-provider/azure/appconfiguration/provider/aio/_azureappconfigurationproviderasync.py

...-appconfiguration-provider/azure/appconfiguration/provider/_azureappconfigurationprovider.py

...pconfiguration/azure-appconfiguration-provider/tests/test_snapshot_references_integration.py

...iguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_client_manager.py

sdk/appconfiguration/azure-appconfiguration-provider/tests/test_request_tracing_context.py

Copilot · 2025-11-20T17:23:34Z

...guration-provider/azure/appconfiguration/provider/aio/_azureappconfigurationproviderasync.py

+                    # Recursively process the resolved snapshot settings to handle feature flags,
+                    # configuration mapping
+                    snapshot_configuration_list = list(snapshot_settings.values())
+                    resolved_settings = await self._process_configurations(snapshot_configuration_list, client)


The recursive call to _process_configurations on line 473 could lead to infinite recursion if a snapshot contains a snapshot reference that points back to itself or creates a circular reference chain. There's no depth tracking or cycle detection to prevent this.

Consider adding a depth limit parameter or cycle detection mechanism to prevent stack overflow from circular snapshot references.

sdk/appconfiguration/azure-appconfiguration-provider/tests/test_request_tracing_context.py

...configuration-provider/azure/appconfiguration/provider/_azureappconfigurationproviderbase.py

...-appconfiguration-provider/azure/appconfiguration/provider/_azureappconfigurationprovider.py

...guration-provider/azure/appconfiguration/provider/aio/_azureappconfigurationproviderasync.py

Co-authored-by: Copilot <[email protected]>

…configuration/provider/_azureappconfigurationproviderbase.py Co-authored-by: Copilot <[email protected]>

avanigupta · 2025-11-20T18:18:24Z

...pconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_constants.py

+APP_CONFIG_SNAPSHOT_REF_MIME_PROFILE = "https://azconfig.io/mime-profiles/snapshot-ref"
+
+# Snapshot reference tracing key
+SNAPSHOT_REFERENCE_TAG = "UsesSnapshotReference=true"


Snapshot ref is part of the features string. Eg: "Features=AI+SnapshotRef"

avanigupta · 2025-11-20T18:35:35Z

...pconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_constants.py

 # Mime profiles
 APP_CONFIG_AI_MIME_PROFILE = "https://azconfig.io/mime-profiles/ai/"
 APP_CONFIG_AICC_MIME_PROFILE = "https://azconfig.io/mime-profiles/ai/chat-completion"
+APP_CONFIG_SNAPSHOT_REF_MIME_PROFILE = "https://azconfig.io/mime-profiles/snapshot-ref"


No need to track MIME profile - just compare with SNAPSHOT_REF_CONTENT_TYPE to check if it's a snapshot reference. We do the same in .net provider: https://github.com/Azure/AppConfiguration-DotnetProvider/blob/34576ef70d303a029b7ea7ef860f12885fb8f35d/src/Microsoft.Extensions.Configuration.AzureAppConfiguration/AzureAppConfigurationProvider.cs#L869C45-L869C57

avanigupta · 2025-11-21T18:01:41Z

...-appconfiguration-provider/azure/appconfiguration/provider/_azureappconfigurationprovider.py


                if self._feature_flag_refresh_enabled:
                    self._watched_feature_flags[(settings.key, settings.label)] = settings.etag
+            elif settings.content_type and SNAPSHOT_REF_CONTENT_TYPE in settings.content_type:


Suggested change

elif settings.content_type and SNAPSHOT_REF_CONTENT_TYPE in settings.content_type:

elif settings.content_type and SNAPSHOT_REF_CONTENT_TYPE == settings.content_type:

avanigupta · 2025-11-21T18:02:13Z

...pconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_constants.py

 APP_CONFIG_AICC_MIME_PROFILE = "https://azconfig.io/mime-profiles/ai/chat-completion"
+
+# Snapshot reference tracing key
+SNAPSHOT_REFERENCE_TAG = "UsesSnapshotReference"


Suggested change

SNAPSHOT_REFERENCE_TAG = "UsesSnapshotReference"

SNAPSHOT_REFERENCE_TAG = "SnapshotRef"

avanigupta · 2025-11-21T18:05:01Z

...pconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_constants.py

+# Snapshot reference tracing key
+SNAPSHOT_REFERENCE_TAG = "UsesSnapshotReference"
+
+# Snapshot reference constants


This file contains all the constants. Could you organize them into sections so that related constants are grouped together? Eg tracing constants, content types, FM constants.

avanigupta · 2025-11-21T18:07:21Z

...zure-appconfiguration-provider/azure/appconfiguration/provider/_snapshot_reference_parser.py

+                           or empty/whitespace snapshot name
+        """
+        if setting is None:
+            raise ValueError("Setting cannot be None")


Does ValueError get handled properly if the provider is optional?

avanigupta · 2025-11-21T18:08:55Z

.../azure-appconfiguration-provider/azure/appconfiguration/provider/_request_tracing_context.py

        if self.is_failover_request:
            tags.append(FAILOVER_TAG)

+        if self.uses_snapshot_reference:


Shouldnt this be part of features_string?

avanigupta · 2025-11-21T18:11:28Z

...iguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_client_manager.py

+            snapshot_selector = SettingSelector(snapshot_name=snapshot_name)
+
+            # Use existing load_configuration_settings to load from snapshot
+            configurations = self.load_configuration_settings([snapshot_selector], **kwargs)


If snapshot contains feature flags, will those be ignored?

avanigupta · 2025-11-21T18:15:25Z

...configuration-provider/azure/appconfiguration/provider/_azureappconfigurationproviderbase.py

                if APP_CONFIG_AICC_MIME_PROFILE in config.content_type:
                    self._tracing_context.uses_aicc_configuration = True
+                if SNAPSHOT_REF_CONTENT_TYPE in config.content_type:
+                    self._tracing_context.uses_snapshot_reference = True


This is already tracked in _process_configurations, do we still need to check content type here?

avanigupta · 2025-11-21T18:27:15Z

...-appconfiguration-provider/azure/appconfiguration/provider/_azureappconfigurationprovider.py

+                self._tracing_context.uses_snapshot_reference = True
+                try:
+                    # Resolve the snapshot reference to actual settings
+                    snapshot_settings = client.resolve_snapshot_reference(settings)


Snapshot references should be resolved before _configuration_mapper is run - i.e. _configuration_mapper runs on all the settings loaded by snapshot or snapshot reference

mrm9084 added 6 commits November 10, 2025 15:29

basic snapshot references

54c46af

async + testsing

00367d4

fixed request tracing

cfa05ef

Update test_request_tracing_context.py

ed2ec31

Update test_snapshot_references.py

0535102

Update test_snapshot_references_integration.py

6401748

Copilot AI review requested due to automatic review settings November 20, 2025 17:11

mrm9084 requested review from albertofori, avanigupta, rossgrambo and xiangyan99 as code owners November 20, 2025 17:11

github-actions bot added the App Configuration Azure.ApplicationModel.Configuration label Nov 20, 2025

Copilot started reviewing on behalf of mrm9084 November 20, 2025 17:12 View session

Copilot finished reviewing on behalf of mrm9084 November 20, 2025 17:15

Copilot AI reviewed Nov 20, 2025

View reviewed changes

mrm9084 and others added 5 commits November 20, 2025 09:46

Apply suggestions from code review

acab089

Co-authored-by: Copilot <[email protected]>

Update sdk/appconfiguration/azure-appconfiguration-provider/azure/app…

a8aa426

…configuration/provider/_azureappconfigurationproviderbase.py Co-authored-by: Copilot <[email protected]>

Update test_async_snapshot_references_integration.py

4a2d7a0

Update test_request_tracing_context.py

bc8744e

Update test_request_tracing_context.py

0d53f38

avanigupta reviewed Nov 20, 2025

View reviewed changes

review comment

2cf138f

avanigupta reviewed Nov 21, 2025

View reviewed changes

	elif settings.content_type and SNAPSHOT_REF_CONTENT_TYPE in settings.content_type:
	elif settings.content_type and SNAPSHOT_REF_CONTENT_TYPE == settings.content_type:

	SNAPSHOT_REFERENCE_TAG = "UsesSnapshotReference"
	SNAPSHOT_REFERENCE_TAG = "SnapshotRef"

App Configuration - Snapshot references #44116

Are you sure you want to change the base?

App Configuration - Snapshot references #44116

Uh oh!

Conversation

mrm9084 commented Nov 20, 2025

Description

All SDK Contribution checklist:

General Guidelines and Best Practices

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Nov 20, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

avanigupta Nov 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

avanigupta Nov 20, 2025 •

edited

Loading